<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: include/trcEvent.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.8.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trcEvent_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">trcEvent.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Public trace event APIs.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;trcTypes.h&gt;</code><br />
</div>
<p><a href="trcEvent_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gac506caaa70d385e64cd0e4fa2ad80a04"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gac506caaa70d385e64cd0e4fa2ad80a04">xTraceEventBegin</a>(uiEventCode,  uiTotalPayloadSize,  pxEventHandle)&#160;&#160;&#160;	(<a class="el" href="trcRecorder_8h.html#a1991479e9a6d6653333f8bb854abbbab">xTraceIsRecorderEnabled</a>() ? xTraceEventBeginOffline(uiEventCode, uiTotalPayloadSize, pxEventHandle) : TRC_FAIL)</td></tr>
<tr class="memdesc:gac506caaa70d385e64cd0e4fa2ad80a04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Begins a trace event.  <br /></td></tr>
<tr class="separator:gac506caaa70d385e64cd0e4fa2ad80a04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3e4d4ace59b52e5c2e80d34b40329917"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga3e4d4ace59b52e5c2e80d34b40329917">xTraceEventEnd</a>(xEventHandle)&#160;&#160;&#160;	(!<a class="el" href="trcRecorder_8h.html#a1991479e9a6d6653333f8bb854abbbab">xTraceIsRecorderEnabled</a>() ? TRC_FAIL : xTraceEventEndOffline(xEventHandle))</td></tr>
<tr class="memdesc:ga3e4d4ace59b52e5c2e80d34b40329917"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends a trace event.  <br /></td></tr>
<tr class="separator:ga3e4d4ace59b52e5c2e80d34b40329917"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd2cdde9951fe313cec11003a4fe203f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gacd2cdde9951fe313cec11003a4fe203f">xTraceEventAddString</a>(xEventHandle,  szString,  uiLength)&#160;&#160;&#160;<a class="el" href="group__trace__event__apis.html#ga112f4b8cbcbe510c9d07db9b90dc620c">xTraceEventAddData</a>(xEventHandle, (TraceUnsignedBaseType_t*)(szString), (((uiLength) + (sizeof(TraceUnsignedBaseType_t) - 1)) / sizeof(TraceUnsignedBaseType_t)))</td></tr>
<tr class="memdesc:gacd2cdde9951fe313cec11003a4fe203f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds string to event payload.  <br /></td></tr>
<tr class="separator:gacd2cdde9951fe313cec11003a4fe203f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3d104209d01e4e1ac2fce7a1c7ebfa69"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga3d104209d01e4e1ac2fce7a1c7ebfa69">xTraceEventGetSize</a>(pvAddress,  puiSize)&#160;&#160;&#160;(*(uint32_t*)(puiSize) = sizeof(TraceEvent0_t) + (TRC_EVENT_GET_PARAM_COUNT(((TraceEvent0_t*)(pvAddress))-&gt;EventID)) * sizeof(uint32_t), TRC_SUCCESS)</td></tr>
<tr class="memdesc:ga3d104209d01e4e1ac2fce7a1c7ebfa69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace event size.  <br /></td></tr>
<tr class="separator:ga3d104209d01e4e1ac2fce7a1c7ebfa69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55e1fd2058f3507101ac46238cfe350d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga55e1fd2058f3507101ac46238cfe350d">xTraceEventGetRawData</a>&#160;&#160;&#160;TRC_EVENT_GET_RAW_DATA</td></tr>
<tr class="memdesc:ga55e1fd2058f3507101ac46238cfe350d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace event data pointer with an offset.  <br /></td></tr>
<tr class="separator:ga55e1fd2058f3507101ac46238cfe350d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0399574efecfbcdb1d92aa176c597f4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gae0399574efecfbcdb1d92aa176c597f4">xTraceEventGetPayload</a>&#160;&#160;&#160;TRC_EVENT_GET_PAYLOAD</td></tr>
<tr class="memdesc:gae0399574efecfbcdb1d92aa176c597f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace event payload pointer with an offset.  <br /></td></tr>
<tr class="separator:gae0399574efecfbcdb1d92aa176c597f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2fe59add1d55f013879ee7d88503f25"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gac2fe59add1d55f013879ee7d88503f25">xTraceEventPayloadRemaining</a>&#160;&#160;&#160;TRC_EVENT_PAYLOAD_REMAINING</td></tr>
<tr class="memdesc:gac2fe59add1d55f013879ee7d88503f25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the amount of remaining trace event payload.  <br /></td></tr>
<tr class="separator:gac2fe59add1d55f013879ee7d88503f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7664fb00364a4a1165dc23074ef698bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga7664fb00364a4a1165dc23074ef698bc">xTraceEventPayloadUsed</a>&#160;&#160;&#160;TRC_EVENT_PAYLOAD_USED</td></tr>
<tr class="memdesc:ga7664fb00364a4a1165dc23074ef698bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the amount of used trace event payload.  <br /></td></tr>
<tr class="separator:ga7664fb00364a4a1165dc23074ef698bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf49b771de784ae6be526dcd1b851d77e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gaf49b771de784ae6be526dcd1b851d77e">xTraceEventPayloadSize</a>&#160;&#160;&#160;TRC_EVENT_PAYLOAD_SIZE</td></tr>
<tr class="memdesc:gaf49b771de784ae6be526dcd1b851d77e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace event payload size.  <br /></td></tr>
<tr class="separator:gaf49b771de784ae6be526dcd1b851d77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga441b595058d45b79be4fe6e7ea4f1507"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga441b595058d45b79be4fe6e7ea4f1507">xTraceEventAddUnsignedBaseType</a>&#160;&#160;&#160;TRC_EVENT_ADD_UNSIGNED_BASE_TYPE</td></tr>
<tr class="memdesc:ga441b595058d45b79be4fe6e7ea4f1507"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an unsigned base type value as trace event payload.  <br /></td></tr>
<tr class="separator:ga441b595058d45b79be4fe6e7ea4f1507"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12fc28f1cd94b5167e0c1c541e2bc123"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga12fc28f1cd94b5167e0c1c541e2bc123">xTraceEventAdd32</a>&#160;&#160;&#160;TRC_EVENT_ADD_32</td></tr>
<tr class="memdesc:ga12fc28f1cd94b5167e0c1c541e2bc123"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an uint32_t as trace event payload.  <br /></td></tr>
<tr class="separator:ga12fc28f1cd94b5167e0c1c541e2bc123"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga117fda02be14d7344c32d80a16a16776"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga117fda02be14d7344c32d80a16a16776">xTraceEventAdd16</a>&#160;&#160;&#160;TRC_EVENT_ADD_16</td></tr>
<tr class="memdesc:ga117fda02be14d7344c32d80a16a16776"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an uint16_t as trace event payload.  <br /></td></tr>
<tr class="separator:ga117fda02be14d7344c32d80a16a16776"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga848f7f80ed87213c0c1d9f74bed0dba5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga848f7f80ed87213c0c1d9f74bed0dba5">xTraceEventAdd8</a>&#160;&#160;&#160;TRC_EVENT_ADD_8</td></tr>
<tr class="memdesc:ga848f7f80ed87213c0c1d9f74bed0dba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an uint8_t as trace event payload.  <br /></td></tr>
<tr class="separator:ga848f7f80ed87213c0c1d9f74bed0dba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf8b45ef0660e9b133d74112710b2f8e9"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gaf8b45ef0660e9b133d74112710b2f8e9">xTraceEventGetSize</a> (const void *const pvAddress, uint32_t *puiSize)</td></tr>
<tr class="memdesc:gaf8b45ef0660e9b133d74112710b2f8e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets trace event size.  <br /></td></tr>
<tr class="separator:gaf8b45ef0660e9b133d74112710b2f8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63f12da033faf0f4de4ef2755d73b308"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga63f12da033faf0f4de4ef2755d73b308">xTraceEventCreate0</a> (uint32_t uiEventCode)</td></tr>
<tr class="memdesc:ga63f12da033faf0f4de4ef2755d73b308"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 0 parameters.  <br /></td></tr>
<tr class="separator:ga63f12da033faf0f4de4ef2755d73b308"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga676dd9f79556a3343072b14fac51af1d"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga676dd9f79556a3343072b14fac51af1d">xTraceEventCreate1</a> (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1)</td></tr>
<tr class="memdesc:ga676dd9f79556a3343072b14fac51af1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 1 parameters.  <br /></td></tr>
<tr class="separator:ga676dd9f79556a3343072b14fac51af1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fcbd638f23ebbe7d9a4447d0338beca"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga5fcbd638f23ebbe7d9a4447d0338beca">xTraceEventCreate2</a> (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2)</td></tr>
<tr class="memdesc:ga5fcbd638f23ebbe7d9a4447d0338beca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 2 parameters.  <br /></td></tr>
<tr class="separator:ga5fcbd638f23ebbe7d9a4447d0338beca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad64822d442e36ad8b008462994442e11"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gad64822d442e36ad8b008462994442e11">xTraceEventCreate3</a> (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3)</td></tr>
<tr class="memdesc:gad64822d442e36ad8b008462994442e11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 3 parameters.  <br /></td></tr>
<tr class="separator:gad64822d442e36ad8b008462994442e11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaadf63a13e25292a1c96330dae5e520b6"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gaadf63a13e25292a1c96330dae5e520b6">xTraceEventCreate4</a> (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4)</td></tr>
<tr class="memdesc:gaadf63a13e25292a1c96330dae5e520b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 4 parameters.  <br /></td></tr>
<tr class="separator:gaadf63a13e25292a1c96330dae5e520b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaebde2bb91d01e7cc4e0c1adac58d46c4"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#gaebde2bb91d01e7cc4e0c1adac58d46c4">xTraceEventCreate5</a> (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5)</td></tr>
<tr class="memdesc:gaebde2bb91d01e7cc4e0c1adac58d46c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 5 parameters.  <br /></td></tr>
<tr class="separator:gaebde2bb91d01e7cc4e0c1adac58d46c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c11b915f0ac18234c3bd2dd7be8610a"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga7c11b915f0ac18234c3bd2dd7be8610a">xTraceEventCreate6</a> (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5, TraceUnsignedBaseType_t uxParam6)</td></tr>
<tr class="memdesc:ga7c11b915f0ac18234c3bd2dd7be8610a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an event with 6 parameters.  <br /></td></tr>
<tr class="separator:ga7c11b915f0ac18234c3bd2dd7be8610a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga112f4b8cbcbe510c9d07db9b90dc620c"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__event__apis.html#ga112f4b8cbcbe510c9d07db9b90dc620c">xTraceEventAddData</a> (TraceEventHandle_t xEventHandle, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)</td></tr>
<tr class="memdesc:ga112f4b8cbcbe510c9d07db9b90dc620c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds data to event payload.  <br /></td></tr>
<tr class="separator:ga112f4b8cbcbe510c9d07db9b90dc620c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Public trace event APIs. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="trcEvent_8h.html">trcEvent.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
